home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 October / Chip_2000-10_cd1.bin / zkuste / MacOS / FILES / MailCli.sit / Documentation / For developers / Creating Plugins. next >
Text File  |  2000-06-30  |  3KB  |  80 lines
  1. Creating plug-ins for MacMail
  2.  
  3.                                                                                                                         Introduction                                                                                                                        
  4. ╩
  5.  
  6.  
  7. Creating plug-ins for MacMail is simple if you know the HyperTalk programming language. This is because, roughly, MacMail plugins are plain text files with HyperTalk code.
  8.  
  9.                                                                                                                         Plug-in file description                                                                                                                        
  10. File Type: ╥Plug╙
  11. File Creator: ╥MMcl╙
  12.  
  13. The first line of your plugin looks (exactly) like this:
  14. -- V0
  15. (that╒s a zero). This is the verison of the plug-in structure. It allows me to make more advanced plug-in structures in the future that won╒t create incompatabilities with the current MacMail.
  16. If you get that line wrong, you get this error:
  17. ╩
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28. After that, the code starts. This is plain HyperTalk code, but you have access to the following XCMDs/XFCNs:
  29.  
  30. XCMDs
  31. ListWindow
  32. WindName
  33. xDialog
  34. CreateFolder
  35. NewAnswer <╤ Use this one for all your alert dialogs! Syntax: http://welcome.to/kalleboo/
  36. Balloons()
  37. ShowList()
  38. FindFolder()
  39. GetDir()
  40. hasAppearance()
  41.  
  42. How to access the messages:
  43. listMessages() -- Returns a list of message subjects
  44. listMessageIDs() -- Returns a list of message IDs
  45. listMessageFolder(folder name) -- Returns a list of the messages in the folder specified. The global ╥FolderMessageIDs╙ is set to a list of the message IDs
  46. saveFolders listOfFolders --replaces the list of folders with the list specified.
  47. readFolders() -- Returns a list of the folders
  48. saveMessage subject, from, to, date, folder, read, bodyText --saves a new message with those properites. Returns the message ID
  49. readMessage whatToRead, ID --Reads a part of a message, can be: "subject", "from", "to", "date", "folder", "read", "body╙
  50. moveMsg ID, where --Moves a message into a folder
  51. markMsg ID -- Marks a message as read
  52. deMarkMsg ID-- Marks a message as unread
  53.  
  54.  
  55.                                                                                                                         Error handling                                                                                                                        
  56. If your code hits upon an error, MacMail will stop the execution, and slap an error dialog:
  57. ╩
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68. You might want to try to do alot of error checking yourself, so you can collect more diagnostic information.
  69.  
  70.                                                                                                                         Good Idea:                                                                                                                        
  71. If you make a plug-in, tell me (kalleboo@yahoo.com) and it might even be included in the MacMail package!
  72.  
  73.                                                                                                                         Installing plug-ins:                                                                                                                        
  74. Pop the plug-in file into the ╥MacMail╙ folder in the ╥Applications Support╙ folder in the system folder.
  75. If you╒re using an OS older than 8.0, it╒ll be directly in the System Folder.
  76.  
  77.                                                                                                                         File name constraints:                                                                                                                        
  78. No commas in the filename. No carriage return in the filename. (a.k.a. return) Nothin gelse freakt in the filename.
  79.  
  80. -Karl B